Read a consumer consent record by consent_id.

GET

consent

consumer

{consent_id}

curl --request GET \
  --url https://api.example.com/v1/consent/consumer/{consent_id} \
  --header 'Authorization: Bearer <token>'

{
  "consent_id": "<string>",
  "field_access_grants": [
    {
      "furnishing_entity_id": "<string>",
      "field_definitions": [],
      "effective_from": "<string>",
      "effective_to": "<string>"
    }
  ],
  "created_at": "<string>",
  "events": "<string>",
  "scope": "<string>",
  "expires_at": "<string>",
  "consented_fields": "<string>"
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

Query Parameters

network_id

string<uuid>

required

Network scope for the consent lookup

Response

Successful Response

Create a consumer consent record (direct, server-to-server). Returns a consent_id used for all subsequent queries.

field_access_grants

FieldAccessGrantOutput · object[]

required

Show child attributes

created_at

string

required

events

string

required

scope

string

required

expires_at

string | null

consented_fields

string | null

Update a consumer consent record's scope, expiry, or consented fieldsUpdate a consumer consent record's scope, expiry, or consented fields. Identity fields are immutable.

⌘I

Read a consumer consent record by consent_id.

curl --request GET \
  --url https://api.example.com/v1/consent/consumer/{consent_id} \
  --header 'Authorization: Bearer <token>'

{
  "consent_id": "<string>",
  "field_access_grants": [
    {
      "furnishing_entity_id": "<string>",
      "field_definitions": [],
      "effective_from": "<string>",
      "effective_to": "<string>"
    }
  ],
  "created_at": "<string>",
  "events": "<string>",
  "scope": "<string>",
  "expires_at": "<string>",
  "consented_fields": "<string>"
}